Document shell completions (but completions)#210
Open
ameyypawar wants to merge 1 commit into
Open
Conversation
`but completions [shell]` generates shell completion scripts but is hidden in the CLI (`#[clap(hide = true)]`) and undocumented. Add a Shell completions section to the CLI installation guide covering bash, zsh, and fish. Closes gitbutlerapp#176
Contributor
|
@ameyypawar is attempting to deploy a commit to the GitButler Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #176.
but completions [shell]generates shell completion scripts, but the command is#[clap(hide = true)], so it's excluded from the generated CLI man-pages and was undocumented. This adds a Shell completions section to the CLI installation guide with copy-paste setup for bash, zsh, and fish.Since the command is hidden, I took the
hideas help-clutter reduction (its doc-comment is labelled "UTILITY:") rather than it being internal/unstable — if it's intentionally not yet public, happy to close this instead.